HyperSpeech.ini Readme for version 1.0.1


Debug Mode
----------
DebugMode:
This the default setting for HyperSpeech to use at startup.
Valid options are 'true' and 'false'.

If DebugMode is set to 'true':
- ReloadRegExHotkey is enabled
- ReloadIniHotkey is enabled
- DebugPopup Windows are enabled that show the optimized (RegExReplaced) 
  strings when pressing the SpeakBioHotkey or the SpeakDescriptionHotkey
  This is useful when you are adding Regular Expression to optimize or 
  change spoken text

DebugPopupTimeout:
This is the timeout before the popup automatically dissapears.
Set this to a value in seconds you find suitable for you.


Hotkeys
-------
DebugModeToggleHotkey:
Toggles the debug mode on or of when HyperSpin is active.

SpeakBioHotkey:
Triggers the bio speech for systems and MAME game bios (History.dat is file is needed for MAME bios).

SpeakDescriptionHotkey:
Manually triggers the game description speech.

ReloadRegExHotkey:
Triggers an instant reload of the HyperSpeech.dat file with the RegExReplace strings.

ReloadIniHotkey:
Triggers an instant reload of the HyperSpeech.ini file, strings and viriables are then reloaded.


Bio Settings
------------
AutoBioDelay:
This is the delay time in miliseconds that HyperSpeech waits before speaking the selected system or MAME game bio.
If the value is set to 0, AutoBioDelay is turned off.

SystemBioEnabled:
Turns the system bio speech on or off.

MAMEBioEnabled:
Turns the MAME game bio speech on or off.

MAMEHistoryDatPath:
This is the path to the MAME history.dat file, needed for the MAME bio.


Generic Settings
----------------
AttractModeSpeechEnabled:
Enables or disables the speech events when attract mode kicks in or ends.

Volume:
This is the TTS engine's speech volume, enter a value from 0 to 100.

HSStartSpeechDelay:
Inserts a pause in x miliseconds before the initial speech is started.
The initial speech might not work if HyperSpeech.exe is not started fast enough the first time 
and the speech engine object is not yet created.

MainSpeechDelay:
Insert a pause in miliseconds before the speech when you enter the main wheel at startup.

GameSpeechDelay:
Insertd a pause in miliseconds before the game description is spoken.
You can tweak this value if you think speech occures too fast when turning the wheel.

SystemSpeechDelay:
Insert a pause in miliseconds before the system's name is spoken.
You can tweak this value if you think speech occures too fast when turning the wheel.

RealLedBlinkyActive:
Set to true is you use Arzoo's LEDBlinky on you setup.
Events are parsed transparantly to LEDBlinky if you setup the right path for it

RealLedBlinkyPath:
Set the full path to Arzoo's LEDBlinky executable if you set the value RealLedBlinkyActive=true


Custom Speech Strings
---------------------
In these you can enter the text you want to be spoken for the different types of LEDBlinky events.
If you enter more than 1 string for an event, then each time a randomly selected string is spoken.
Insert some blank lines of you think HyperSpeech should shut up more often.


System Bios
-----------
You can create a section for each system you have in your setup.
The section must correspond to the system names in your Main Menu.xml.
The Bios are also being 'RegExed' before spoken, there certain text will also be replaced, like most stuf in between ( ) 

Please mind:
When you use the words "The ", "Le " or "A " (with a capital) after a comma somewhere in your text, then it will be placed at the beginning of the string and thus mess it up.
This still needs to be fixed by a good RegEx variable in the HyperSpeech.dat file.